<?php
/**
 * Mechanism
 *
 * LICENSE
 *
 * Copyright (c) 2011, Sergey A. Ivonchik <BreatheInMyVoid@gmail.com>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * * Redistributions in binary form must reproduce the above
 *   copyright notice, this list of conditions and the following disclaimer
 *   in the documentation and/or other materials provided with the
 *   distribution.
 * * Neither the name of the  nor the names of its
 *   contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * @package Mechanism
 * @license http://www.opensource.org/licenses/bsd-license
 * @author Sergey A. Ivonchik <BreatheInMyVoid@gmail.com>
 * @copyright Copyright (c) 2011 Sergey A. Ivonchik
 */

namespace Mechanism\Router\Route {
 	/**
 	 * Interface for route rules
	 *
 	 * @package Mechanism\Router\Route
 	 * @author BreatheInMyVoid <BreatheInMyVoid@gmail.com>
 	 */
	interface IRoute {
		/**
		 * Set parameter of a route
		 *
		 * This method sets special parameter for
		 * a route f.e. module, controller, action
		 * and etc.
		 *
		 * @param string $name
		 * @param string $value
		 */
		public function set( $name, $value );

		/**
		 * Get parameter of a route
		 *
		 * This method gets special parameter of a route
		 * or all parameters if called without arguments.
		 * Using this method you can get route parameters
		 * after route matching. Before matching it returns
		 * parameters which you setted up manually.
		 * This is a "main" method of a routes. Basicly
		 * this method should return what you need after routing
		 * and its value.
		 *     $route = array(
		 *         'module' => 'main',
		 *         'controller' => 'index',
		 *		   'action' => 'index'
		 *	   );
		 *
		 *     $route = array(
		 *         'module' => 'main',
		 *         'page' => 'show',
		 *	   );
		 * Using this system we can return any parameters
		 * you want. But you must think about returning data
		 * because some objects expects some parameters from
		 * this method. F.e. Front controller expects module,
		 * controller and action, page conroller expects page.
		 * This method it is alternative to the countless
		 * generation of getters and setters.
		 *
		 * @param string $name = null
		 * @return string $param
		 * @return array $params
		 */
		public function get( $name = null );

		/**
		 * Match path
		 *
		 * This method matches given path on
		 * pattern matching.
		 * (Update*)In our default routes we using concept 
		 * that if user do not setup default params 
		 * for route, and thare is no params in url,
		 * then match( ) return false. This feature 
		 * is very useful for Complex router when you 
		 * want to match several routes.
		 *
		 * @param string $path
		 * @return bool $result
		 */
		public function match( $path );
	}
}